doc: zigbee: add known issue NCSIDB-1411 #19688
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add known issue about omitted ZCL Reporting configuration wipe when processing Mgmt_Leave_req command. Signed-off-by: Adam Zelik <[email protected]>
github-actions
bot
added
doc-required
CI InformationTo view the history of this post, clich the 'edited' button above Inputs:Sources:sdk-nrf: PR head: e66cc88bb6f2f9c99e51bb5d2d983b76585439d9 more detailssdk-nrf:
Github labels
List of changed files detected by CI (1)Outputs:ToolchainVersion: Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped;
|
|
You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds. Note: This comment is automatically posted by the Documentation Publish GitHub Action. |
annwoj
reviewed
Dec 23, 2024
Comment on lines
+1227
to
+1228
| NCSIDB-1411: Clearing config data in response to the Leave Network command is not fully performed | ||
| Configuration data of ZCL Reporting feature is not cleared when processing the "Leave Network" command, which means that compliance with the specification is incomplete. |
There was a problem hiding this comment.
Suggested change
| NCSIDB-1411: Clearing config data in response to the Leave Network command is not fully performed | |
| Configuration data of ZCL Reporting feature is not cleared when processing the "Leave Network" command, which means that compliance with the specification is incomplete. | |
| NCSIDB-1411: Clearing configuration data is not fully performed when processing the leave network command | |
| Configuration data of ZCL Reporting feature is not cleared when processing the leave network command, resulting in incomplete compliance with the specification. |
There was a problem hiding this comment.
Proposal to update @annwoj suggestion with Leave Network command by starting the name with capital letter
Suggested change
| NCSIDB-1411: Clearing config data in response to the Leave Network command is not fully performed | |
| Configuration data of ZCL Reporting feature is not cleared when processing the "Leave Network" command, which means that compliance with the specification is incomplete. | |
| NCSIDB-1411: Clearing configuration data is not fully performed when processing the Leave Network command | |
| Configuration data of ZCL Reporting feature is not cleared when processing the leave network command, resulting in incomplete compliance with the specification. |
@annwoj please comment.
There was a problem hiding this comment.
Should we have he command name highlighted (in double backticks)? Or is it a name or just description?
annwoj
reviewed
Dec 23, 2024
|
|
||
| The Zigbee BDB 3.0 Specification, section 9.4 says that all Zigbee persistent data (with exceptions ..) must be cleared in response to the Mgmt_Leave_req command, however the stack leaves the ZCL Reporting parameter values set (cached in memory) and continues to use them. | ||
|
|
||
| **Workaround:** You can supplement the processing of the "Leave Network" command with ZCL Reporting parameter clearing by adding a :c:func:`zb_zcl_init_reporting_info` call in the ``ZB_ZDO_SIGNAL_LEAVE`` handler. |
There was a problem hiding this comment.
Suggested change
| **Workaround:** You can supplement the processing of the "Leave Network" command with ZCL Reporting parameter clearing by adding a :c:func:`zb_zcl_init_reporting_info` call in the ``ZB_ZDO_SIGNAL_LEAVE`` handler. | |
| **Workaround:** You can supplement the processing of the leave network command with ZCL Reporting parameter clearing by adding a :c:func:`zb_zcl_init_reporting_info` call in the ``ZB_ZDO_SIGNAL_LEAVE`` handler. |
There was a problem hiding this comment.
Same proposal as above - Leave Network command by starting the name with capital letter
Suggested change
| **Workaround:** You can supplement the processing of the "Leave Network" command with ZCL Reporting parameter clearing by adding a :c:func:`zb_zcl_init_reporting_info` call in the ``ZB_ZDO_SIGNAL_LEAVE`` handler. | |
| **Workaround:** You can supplement the processing of the Leave Network command with ZCL Reporting parameter clearing by adding a :c:func:`zb_zcl_init_reporting_info` call in the ``ZB_ZDO_SIGNAL_LEAVE`` handler. |
@annwoj please comment
There was a problem hiding this comment.
I'm fine with that approach
|
I'm good with Anna's suggestions. |
peknis
approved these changes
Dec 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add known issue about omitted ZCL Reporting configuration wipe when processing Mgmt_Leave_req command.